home *** CD-ROM | disk | FTP | other *** search
/ AGA Toolkit '97 / The AGA Toolkit '97.iso / miscellaneous / help / dos / sf / sf.doc < prev    next >
Encoding:
Text File  |  1996-09-07  |  5.5 KB  |  157 lines
  1.                                SF. User Guide
  3.                      Copyright ©1993 Silicon Based Life
  4.  
  5.  
  6. WHAT DOES SF. DO?
  7.  
  8. SF. stands for Software Failure.  No, the program doesn't generate software
  9. failures (or at least I hope not!) - when confronted with a 8 hex digit
  10. code, it tries to tell you as much as it can derive about what your Amiga
  11. was doing at the moment the error occured.  It's a programmer's tool.
  12.  
  13. I am well aware that such programs already exist, I wrote the program for
  14. two good reasons.  When programming the Amiga, sooner or later you will
  15. feel the need to meditate with the Guru.  When this happened to me prior to
  16. SF., I would feed the number into an long standing alert number conversion
  17. program (widely available) and turn up a complete blank.  The reason? - The
  18. program was written in the days of WB1.3 (remember that?).  Which sent me
  19. on a trip down the includes path to find the alerts header file in order to
  20. derive the code - nearly every time (a little tedious).
  21.  
  22. SF. is conversant in all software failures that can be generated up to
  23. KickStart/ Workbench 3.0 that are made known by Commodore to the `consumer
  24. grade' programmer.
  25.  
  26. SF. will also try to tell you as much as it can, even if that is very
  27. little, when it does not know the more specific nature of an error - for
  28. instance it may tell you that intuition.library was the source of the error
  29. even if it knows not what the error was - so that at least you know where
  30. you might start looking.
  31.  
  32.  
  33. HOW DO I MAKE SF. WORK?
  34.  
  35. Make sure that you are running at least Kickstart version 2 and are in a
  36. Shell window.  (Due to the nature of the program, SF. will only run from
  37. the CLI.)
  38.  
  39. Simply type `SF' followed by the 8 digit hex number that was displayed in
  40. your software failure.
  41.  
  42. For example,
  43.  
  44. 1.Apps:Programming> SF 81000009
  45.  
  46. Hex digits A-F can be entered in either upper or lower case or mixed.
  47.  
  48.  
  49. INTERPRETATION OF THE OUTPUT
  50.  
  51. Typical output from SF. looks like this,
  52.  
  53.  
  54. Software Failure : 81000009
  55.             Type : Dead end alert.
  56.       Sub-System : exec.library.
  57.   Specific Error : Freeing memory that has already been freed.
  58.  
  59. The error was a dead end alert (the machine reset), it occured within an
  60. exec.library operation and was an attempt by your program to free some
  61. already free memory.
  62.  
  63.  
  64. Software Failure : 04000123
  65.             Type : Recoverable alert.
  66.       Sub-System : intuition.library.
  67.  
  68. This time, the specifics of the error are unknown, however, SF. knows the
  69. error was in an intuition.library operation.
  70.  
  71.  
  72. Software Failure : 04010123
  73.             Type : Recoverable alert.
  74.       Sub-System : intuition.library.
  75.    General Error : Out of memory.
  76.  
  77. Again, the specifics are unknown, but SF. can tell that the error was
  78. related to a lack of memory.
  79.  
  80.  
  81. Software Failure : 05038015
  82.             Type : Recoverable alert.
  83.       Sub-System : math.library.
  84.    General Error : OpenLibrary().
  85.           Object : timer.device.
  86.  
  87. In this final example it is important to note the ordering.  The meaning of
  88. the output is that timer.device was unable to open math.library.  The
  89. object is the performer, the error was with opening the library and the
  90. library in question is math.library.  The example makes no sense back to
  91. front anyhow since `General Error' should otherwise read OpenDevice().
  92.  
  93.  
  94. WHO ARE SILICON BASED LIFE?
  95.  
  96. Silicon Based Life are a small group of dedicated Amiga enthusiasts, who
  97. enjoy to use and to develop for the machine.  We attempt to understand and
  98. to appreciate all that is the technological masterpiece that the Amiga
  99. range represents and try to present it in it's best light in what ever way
  100. we can find.
  101.  
  102. We are a varied group of individuals, each with differing levels of
  103. experience, but all with a passion for getting the best out of our
  104. equally diverse Amiga computers.
  105.  
  106. Please enjoy your Amiga, in the knowledge that you have the finest in
  107. computer hardware that your money could buy.  Thankyou.
  108.  
  109.  
  110. WHAT DO SBL. WANT?
  111.  
  112. SF. is Freeware, however if you want to help us, please send a letter or a
  113. pretty postcard to the address below, stating which product (SF.) you are
  114. using.  This allows us to gauge the response to each completed package and
  115. to therefor direct our activities as best as possible.  Money is of course
  116. welcome, but, must be in UK pounds (lots of them!).
  117.  
  118. If you have any suggestions or have discovered a bug, please write with a
  119. detailed description to
  120.  
  121.  
  122.                            James Ling
  123.  
  124.                            93 Weatherbury Way
  125.                            Dorchester
  126.                            Dorset     DT1 2EE
  127.                            England
  128.  
  129.  
  130. Please remember that it is helpful to include a description of your
  131. Amiga setup - model, RAM size, Hard disk, monitor type, esp. when reporting
  132. possible faults.
  133.  
  134. Writing does not guarantee a reply, (an SAE increases your chances), but I
  135. will try to reply to most sensible correspondence.
  136.  
  137.  
  138. DISCLAIMER
  139.  
  140. Silicon Based Life does not take any responsibility for any damage, loss of
  141. data, caused directly or indirectly by the use of SF. or any of the
  142. associated material.  A standard text accompanies each package, Legal.doc,
  143. which must accompany the package when it is duplicated.
  144.  
  145.  
  146. DISTRIBUTION
  147.  
  148. SF. may be distributed freely, however, we request that only a minimal fee
  149. should be charged to cover the duplication service (if you have paid more
  150. than a couple of quid, you've been ripped off.)
  151.  
  152. SF. may be freely included on coverdisks and other such large scale
  153. distributions.
  154.  
  155.  
  156.  
  157.